/*
 * Copyright (C) 2012  Romain DUBOIS
 * 
 * This file is part of NeMoS - Network and Modular Software
 * 
 * NeMoS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NeMoS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NeMoS.  If not, see <http://www.gnu.org/licenses/>.
 */
package nemos.resources.impl;

import java.io.File;

/**
 * IExternalFolder : The external folder interface.
 * 
 * <p>
 * A service implementing this interface provides an access to external files of
 * a specific type. This type is specified by the service property
 * {@link #TYPE_PROPERTY}.
 * </p>
 * 
 * <p>
 * The implementation handles the mapping name <-> java File and ensures that
 * the returned files can be created.
 * </p>
 * 
 * @author Romain DUBOIS
 */
public interface IExternalFolder {

    /** The type property name */
    String TYPE_PROPERTY = "nemos.resources.folder.type"; //$NON-NLS-1$

    /**
     * Get the file object matching the provided name.
     * 
     * @param pName
     *            The file name
     * @return The file in the persistent folder.
     */
    File getExternalFile(String pName);
}
